home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1995 October / EnigmA AMIGA RUN 01 (1995)(G.R. Edizioni)(IT)[!][issue 1995-10][Aminet 7].iso / Aminet / comm / cnet / Cnetcal.lha / calendar / calendar.doc < prev    next >
Text File  |  1994-07-19  |  7KB  |  139 lines
  1. /*****************************************************************************
  2.  *           CNet Events Calendar 2.0 (c) Stan Smith-  6 July 1994           *
  3.  *                                                                           *
  4.  * Either add as a standard AREXX Pfile/GFile (no arguments needed) or       *
  5.  * install in sys.welcome as {#0 pfiles:calendar/calendar}Press [enter]{g32} *
  6.  *                           |                                               *
  7.  *                           `- all {'s are control-Q                        *
  8.  *   You may change the path if you wish to move the calendar data file.     *
  9.  *     The format of the data file should be self-explanatory...             *
  10.  *   The two comment lines below may be changed to whatever you wish; you    *
  11.  *     have 41 characters to play with.  This text is auto-centered, so      *
  12.  *     don't worry about formatting it.                                      *
  13.  *                                                                           *
  14.  *      I can be reached at:  Surface Normal BBS   (209)725-2623,,,22222222  *
  15.  *                            Fido   1:208/602.0                             *
  16.  *****************************************************************************/
  17.  
  18. ______________________________________________________________________________
  19.  
  20. THANKS!
  21.  
  22.   Thanks for looking at/using my little calendar program.  This file will
  23. contain instructions for installation and use of this program, along with
  24. any information about updates and changes.  Please read it with any new
  25. versions you download, since it might contain important information about
  26. changes in operation.
  27.  
  28.   If you have any suggestions, please send them to me via either my BBS or
  29. a message to Ignus Fast on Future World!
  30.  
  31.   I'd like to thank CNet sysop "Bill The Cat" for his comments and
  32. suggestions!  Hope this is closer to what you want...
  33.  
  34. ______________________________________________________________________________
  35.  
  36. INSTALLATION:
  37.  
  38.   You can install this program as either a PFile, GFile, or logon macro- I
  39. use it as a GFile and in my startup sequence.  To install as a standard
  40. GFile or PFile, just (A)dd it as a standard AREXX file.  There is one
  41. optional agrument you can add before calling this program, but it would
  42. only be used in the instance of a nightly (bi-nightly, or whatever schedule
  43. you prefer) event.
  44.  
  45.   To install as a logon macro, just edit the file SYSTEXT:SYS.WELCOME, and
  46. add (at whatever point in the logon you wish your users to see the
  47. calendar!)
  48.  
  49.                {#0 pfiles:calendar/calendar}
  50.                |
  51.                `------- { always means control-Q
  52.  
  53.  
  54.  
  55. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  56.  
  57.   There are three optional display arguments that I will explain before I get
  58. into the *required one.
  59.  
  60.   The first display argument is BDAYS.  If you add this, as follows:
  61.           {#0 pfiles:calendar/calendar bdays}
  62. the program will ONLY display your BBS users birthdays, and NOT normal
  63. system events.
  64.  
  65.   The second is NORMAL.  If you add this, then the program
  66. will display system events and ignore the birthdays file.
  67.  
  68.   The final display argument is BOTH.  If you add this, then the program will
  69. display the systems events, wait for a key press, then display user birthdays.
  70.  
  71.   If you call it without ANY arguments, it will come up and ask the user
  72. which one they wish to view.  They also have the option of (Q)uitting.
  73.  
  74. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  75.  
  76. * Finally, you need to add the Calendar event; This will compile all of your
  77. users birthdays into a calendar file for optional viewing.  I did not add
  78. it to the normal data file, because on even a medium-sized system, this will
  79. likely result in more events for a month than the program can display.  If
  80. I can figure out a better way to display more than 15 verbose events in one
  81. month, this will change.  To add this nightly event, run the CNet CONFIG
  82. program and add a new event, set up as:
  83.  
  84.     Argument:   Pfiles:calendar/calendar.rexx event
  85.     Port:       0      (Or wherever you run your nightly maintenance files)
  86.     Type:       Only if system is idle (Again, use your judgement here)
  87.     Checkmark   Sun-Sat  (Or whatever days you wish it to run)
  88.     Time:       0 (midnight)
  89.     Valid:      100 (for up to one hour past midnight if the port is busy)
  90.     Interval:   0 (It should only run one time during that hour, so spacing
  91.                   is not necessary)
  92.     Iterate:    1 (Do it once)
  93.  
  94.  
  95. ______________________________________________________________________________
  96.  
  97. USE:
  98.  
  99.   When a user runs it, it will ask them if they wish to view either the
  100. normal events file, or the optional user birthday file.  The two files
  101. cannot at this time be mixed; again, I may change this in future revisions.
  102. In any case, if you install the archive as-is, it should run fine.  There
  103. are 3 lines in the code you may wish to change, however.
  104.  
  105.   If you decide to store the calendar data files in other than
  106. "PFiles:calendar/"  you may do so.
  107.  
  108.   There are also two comment lines, called FR.6 and FR.7.  These may
  109. contain anything you wish, with two restrictions.  They are auto-centered
  110. by the program, so you do not need to format them; and they must be no
  111. longer than 41 characters.  Note that you CAN include simple ANSI lines in
  112. them; the program will automatically strip those out.
  113.  
  114. ______________________________________________________________________________
  115.  
  116. UPDATES:
  117.  
  118. Ver 2.0
  119.  6 Jul 94 - Added the birthday event and option to view user birthdays.
  120.           - Made the code a little more robust, and added the auto-wrapping
  121.             of events to the next calendar year when near the end of the
  122.             current year.
  123.  
  124. Ver 2.1
  125. 14 Jul 94 - Added a check routine so you are not required to end the PATH=
  126.             statement with a slash; it IS a good habit to get in, however,
  127.             since legal paths require it...
  128.           - Made the title line indicate whether it is an Events calendar
  129.             or a User Birthday calendar.
  130.           - Made some more minor improvements in the code; does not affect
  131.             operation.  Just trying to improve/optimize my use of AREXX.
  132.  
  133. Ver 2.2
  134. 18 Jul 94 - Made some more invisible improvments to the code
  135.           - Added the Press [enter]{g1} prompt into the program
  136.           - Added the BOTH argument to display both calendars sequentially
  137.  
  138. ______________________________________________________________________________
  139.